Documentation
| Parameter | Description | Values / Default |
|---|---|---|
| write.snapshot | Enables or disables generating a snapshot of the documentation whenever a scenario is deployed or modified. | true = snapshots enabledfalse = no snapshots |
| snapshot.path | Directory path where Orchestra writes documentation snapshots. Has no effect if write.snapshot=false. | – |
| external_url_pattern. | Defines URL patterns pointing to external content (e.g., hosted docs). Variables inside the pattern (e.g., $(scenarioname)) are replaced with contextual values. Empty = no URL displayed. | – |
Recognized Pattern Suffixes
| Suffix | Available Variables | Where URL Appears |
|---|---|---|
| .scenario | nodeid, scenarioname, scenarioid | Scenario overview (table column), Scenario detail dialog |
| .landscape | nodeid, scenarioname, scenarioid, landscapename | Landscape overview (table column) |
| .channel | nodeid, scenarioname, scenarioid, channelname | Channel overview (table column), Channel detail dialog |
| .signal | nodeid, signalname | Signal overview |
| .service | nodeid, scenarioname, scenarioid, servicename | Service registry |
Available Variables
| Variable | Expanded Value |
|---|---|
| nodeid | Identifier of the current Orchestra Node |
| scenarioname | Name of the scenario (e.g., sc_client) |
| scenarioid | Unique identifier of the scenario (e.g., 57aa913e-3b2c-40a8-8c6d-f26595cdef44) |
| landscapename | Name of the environment/landscape entry |
| channelname | Name of the channel |
| signalname | Name of the signal |
| servicename | Name of the SOAP or REST service |
Example
Documentation.external_url_pattern.scenario=https://docuhost.local/orchestra/$(scenarioname)